Search for the state of golden record tasks by task identifiers
Returns the state of golden record tasks based on the provided task identifiers. Unknown task identifiers are ignored.
- application/json
Request Body required
- taskIds string[] required
- 200
- 400
The state of the tasks for the provided task identifiers.
- application/json
- Schema
- Example (from schema)
Schema
tasks object[]
taskId stringrecordId stringThe identifier of the gate record for which this task has been created
businessPartnerResult object
The business partner data to be processed
nameParts object[]
name stringtype stringPossible values: [
LegalName
,ShortName
,LegalForm
,SiteName
,AddressName
]owningCompany stringuncategorized object
nameParts string[]identifiers object[]
value stringtype stringissuingBody stringstates object[]
validFrom date-timevalidTo date-timetype stringPossible values: [
ACTIVE
,INACTIVE
]address object
bpnReference object
referenceValue stringdesiredBpn stringreferenceType stringPossible values: [
Bpn
,BpnRequestIdentifier
]addressName stringidentifiers object[]
value stringtype stringissuingBody stringstates object[]
validFrom date-timevalidTo date-timetype stringPossible values: [
ACTIVE
,INACTIVE
]confidenceCriteria object
sharedByOwner booleancheckedByExternalDataSource booleannumberOfSharingMembers int32lastConfidenceCheckAt date-timenextConfidenceCheckAt date-timeconfidenceLevel int32physicalAddress object
geographicCoordinates object
longitude floatlatitude floataltitude floatcountry stringadministrativeAreaLevel1 stringadministrativeAreaLevel2 stringadministrativeAreaLevel3 stringpostalCode stringcity stringdistrict stringstreet object
name stringhouseNumber stringhouseNumberSupplement stringmilestone stringdirection stringnamePrefix stringadditionalNamePrefix stringnameSuffix stringadditionalNameSuffix stringcompanyPostalCode stringindustrialZone stringbuilding stringfloor stringdoor stringtaxJurisdictionCode stringalternativeAddress object
geographicCoordinates object
longitude floatlatitude floataltitude floatcountry stringadministrativeAreaLevel1 stringpostalCode stringcity stringdeliveryServiceType stringPossible values: [
PO_BOX
,PRIVATE_BAG
,BOITE_POSTALE
]deliveryServiceQualifier stringdeliveryServiceNumber stringhasChanged booleanlegalEntity object
bpnReference object
referenceValue stringdesiredBpn stringreferenceType stringPossible values: [
Bpn
,BpnRequestIdentifier
]legalName stringlegalShortName stringlegalForm stringidentifiers object[]
value stringtype stringissuingBody stringstates object[]
validFrom date-timevalidTo date-timetype stringPossible values: [
ACTIVE
,INACTIVE
]confidenceCriteria object
sharedByOwner booleancheckedByExternalDataSource booleannumberOfSharingMembers int32lastConfidenceCheckAt date-timenextConfidenceCheckAt date-timeconfidenceLevel int32isCatenaXMemberData booleanhasChanged booleanlegalAddress object
bpnReference object
referenceValue stringdesiredBpn stringreferenceType stringPossible values: [
Bpn
,BpnRequestIdentifier
]addressName stringidentifiers object[]
value stringtype stringissuingBody stringstates object[]
validFrom date-timevalidTo date-timetype stringPossible values: [
ACTIVE
,INACTIVE
]confidenceCriteria object
sharedByOwner booleancheckedByExternalDataSource booleannumberOfSharingMembers int32lastConfidenceCheckAt date-timenextConfidenceCheckAt date-timeconfidenceLevel int32physicalAddress object
geographicCoordinates object
longitude floatlatitude floataltitude floatcountry stringadministrativeAreaLevel1 stringadministrativeAreaLevel2 stringadministrativeAreaLevel3 stringpostalCode stringcity stringdistrict stringstreet object
name stringhouseNumber stringhouseNumberSupplement stringmilestone stringdirection stringnamePrefix stringadditionalNamePrefix stringnameSuffix stringadditionalNameSuffix stringcompanyPostalCode stringindustrialZone stringbuilding stringfloor stringdoor stringtaxJurisdictionCode stringalternativeAddress object
geographicCoordinates object
longitude floatlatitude floataltitude floatcountry stringadministrativeAreaLevel1 stringpostalCode stringcity stringdeliveryServiceType stringPossible values: [
PO_BOX
,PRIVATE_BAG
,BOITE_POSTALE
]deliveryServiceQualifier stringdeliveryServiceNumber stringhasChanged booleansite object
bpnReference object
referenceValue stringdesiredBpn stringreferenceType stringPossible values: [
Bpn
,BpnRequestIdentifier
]siteName stringstates object[]
validFrom date-timevalidTo date-timetype stringPossible values: [
ACTIVE
,INACTIVE
]confidenceCriteria object
sharedByOwner booleancheckedByExternalDataSource booleannumberOfSharingMembers int32lastConfidenceCheckAt date-timenextConfidenceCheckAt date-timeconfidenceLevel int32hasChanged booleansiteMainAddress object
bpnReference object
referenceValue stringdesiredBpn stringreferenceType stringPossible values: [
Bpn
,BpnRequestIdentifier
]addressName stringidentifiers object[]
value stringtype stringissuingBody stringstates object[]
validFrom date-timevalidTo date-timetype stringPossible values: [
ACTIVE
,INACTIVE
]confidenceCriteria object
sharedByOwner booleancheckedByExternalDataSource booleannumberOfSharingMembers int32lastConfidenceCheckAt date-timenextConfidenceCheckAt date-timeconfidenceLevel int32physicalAddress object
geographicCoordinates object
longitude floatlatitude floataltitude floatcountry stringadministrativeAreaLevel1 stringadministrativeAreaLevel2 stringadministrativeAreaLevel3 stringpostalCode stringcity stringdistrict stringstreet object
name stringhouseNumber stringhouseNumberSupplement stringmilestone stringdirection stringnamePrefix stringadditionalNamePrefix stringnameSuffix stringadditionalNameSuffix stringcompanyPostalCode stringindustrialZone stringbuilding stringfloor stringdoor stringtaxJurisdictionCode stringalternativeAddress object
geographicCoordinates object
longitude floatlatitude floataltitude floatcountry stringadministrativeAreaLevel1 stringpostalCode stringcity stringdeliveryServiceType stringPossible values: [
PO_BOX
,PRIVATE_BAG
,BOITE_POSTALE
]deliveryServiceQualifier stringdeliveryServiceNumber stringhasChanged booleansiteMainIsLegalAddress booleanadditionalAddress object
bpnReference object
referenceValue stringdesiredBpn stringreferenceType stringPossible values: [
Bpn
,BpnRequestIdentifier
]addressName stringidentifiers object[]
value stringtype stringissuingBody stringstates object[]
validFrom date-timevalidTo date-timetype stringPossible values: [
ACTIVE
,INACTIVE
]confidenceCriteria object
sharedByOwner booleancheckedByExternalDataSource booleannumberOfSharingMembers int32lastConfidenceCheckAt date-timenextConfidenceCheckAt date-timeconfidenceLevel int32physicalAddress object
geographicCoordinates object
longitude floatlatitude floataltitude floatcountry stringadministrativeAreaLevel1 stringadministrativeAreaLevel2 stringadministrativeAreaLevel3 stringpostalCode stringcity stringdistrict stringstreet object
name stringhouseNumber stringhouseNumberSupplement stringmilestone stringdirection stringnamePrefix stringadditionalNamePrefix stringnameSuffix stringadditionalNameSuffix stringcompanyPostalCode stringindustrialZone stringbuilding stringfloor stringdoor stringtaxJurisdictionCode stringalternativeAddress object
geographicCoordinates object
longitude floatlatitude floataltitude floatcountry stringadministrativeAreaLevel1 stringpostalCode stringcity stringdeliveryServiceType stringPossible values: [
PO_BOX
,PRIVATE_BAG
,BOITE_POSTALE
]deliveryServiceQualifier stringdeliveryServiceNumber stringhasChanged booleantype stringPossible values: [
LegalEntity
,Site
,Address
]processingState object
Contains detailed information about the current processing state of a golden record task
resultState stringPossible values: [
Pending
,Success
,Error
]The processing result of the task, can also still be pending
step stringPossible values: [
CleanAndSync
,PoolSync
,Clean
]The last step this task has entered
stepState stringPossible values: [
Queued
,Reserved
,Success
,Error
]Whether the task is queued or already reserved for the latest step
errors object[]
The actual errors that happened during processing if the task has an error result state. The errors refer to the latest step.
type stringPossible values: [
Timeout
,Unspecified
]The type of error that occurred
description stringThe free text, detailed description of the error
createdAt date-timeWhen the task has been created
modifiedAt date-timeWhen the task has last been modified
timeout date-time deprecatedThe timestamp until the task is removed from the Orchestrator
{
"tasks": [
{
"taskId": "string",
"recordId": "string",
"businessPartnerResult": {
"nameParts": [
{
"name": "string",
"type": "LegalName"
}
],
"owningCompany": "string",
"uncategorized": {
"nameParts": [
"string"
],
"identifiers": [
{
"value": "string",
"type": "string",
"issuingBody": "string"
}
],
"states": [
{
"validFrom": "2024-07-15",
"validTo": "2024-07-15",
"type": "ACTIVE"
}
],
"address": {
"bpnReference": {
"referenceValue": "string",
"desiredBpn": "string",
"referenceType": "Bpn"
},
"addressName": "string",
"identifiers": [
{
"value": "string",
"type": "string",
"issuingBody": "string"
}
],
"states": [
{
"validFrom": "2024-07-15",
"validTo": "2024-07-15",
"type": "ACTIVE"
}
],
"confidenceCriteria": {
"sharedByOwner": true,
"checkedByExternalDataSource": true,
"numberOfSharingMembers": 0,
"lastConfidenceCheckAt": "2024-07-15",
"nextConfidenceCheckAt": "2024-07-15",
"confidenceLevel": 0
},
"physicalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "string",
"administrativeAreaLevel1": "string",
"administrativeAreaLevel2": "string",
"administrativeAreaLevel3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"street": {
"name": "string",
"houseNumber": "string",
"houseNumberSupplement": "string",
"milestone": "string",
"direction": "string",
"namePrefix": "string",
"additionalNamePrefix": "string",
"nameSuffix": "string",
"additionalNameSuffix": "string"
},
"companyPostalCode": "string",
"industrialZone": "string",
"building": "string",
"floor": "string",
"door": "string",
"taxJurisdictionCode": "string"
},
"alternativeAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "string",
"administrativeAreaLevel1": "string",
"postalCode": "string",
"city": "string",
"deliveryServiceType": "PO_BOX",
"deliveryServiceQualifier": "string",
"deliveryServiceNumber": "string"
},
"hasChanged": true
}
},
"legalEntity": {
"bpnReference": {
"referenceValue": "string",
"desiredBpn": "string",
"referenceType": "Bpn"
},
"legalName": "string",
"legalShortName": "string",
"legalForm": "string",
"identifiers": [
{
"value": "string",
"type": "string",
"issuingBody": "string"
}
],
"states": [
{
"validFrom": "2024-07-15",
"validTo": "2024-07-15",
"type": "ACTIVE"
}
],
"confidenceCriteria": {
"sharedByOwner": true,
"checkedByExternalDataSource": true,
"numberOfSharingMembers": 0,
"lastConfidenceCheckAt": "2024-07-15",
"nextConfidenceCheckAt": "2024-07-15",
"confidenceLevel": 0
},
"isCatenaXMemberData": true,
"hasChanged": true,
"legalAddress": {
"bpnReference": {
"referenceValue": "string",
"desiredBpn": "string",
"referenceType": "Bpn"
},
"addressName": "string",
"identifiers": [
{
"value": "string",
"type": "string",
"issuingBody": "string"
}
],
"states": [
{
"validFrom": "2024-07-15",
"validTo": "2024-07-15",
"type": "ACTIVE"
}
],
"confidenceCriteria": {
"sharedByOwner": true,
"checkedByExternalDataSource": true,
"numberOfSharingMembers": 0,
"lastConfidenceCheckAt": "2024-07-15",
"nextConfidenceCheckAt": "2024-07-15",
"confidenceLevel": 0
},
"physicalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "string",
"administrativeAreaLevel1": "string",
"administrativeAreaLevel2": "string",
"administrativeAreaLevel3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"street": {
"name": "string",
"houseNumber": "string",
"houseNumberSupplement": "string",
"milestone": "string",
"direction": "string",
"namePrefix": "string",
"additionalNamePrefix": "string",
"nameSuffix": "string",
"additionalNameSuffix": "string"
},
"companyPostalCode": "string",
"industrialZone": "string",
"building": "string",
"floor": "string",
"door": "string",
"taxJurisdictionCode": "string"
},
"alternativeAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "string",
"administrativeAreaLevel1": "string",
"postalCode": "string",
"city": "string",
"deliveryServiceType": "PO_BOX",
"deliveryServiceQualifier": "string",
"deliveryServiceNumber": "string"
},
"hasChanged": true
}
},
"site": {
"bpnReference": {
"referenceValue": "string",
"desiredBpn": "string",
"referenceType": "Bpn"
},
"siteName": "string",
"states": [
{
"validFrom": "2024-07-15",
"validTo": "2024-07-15",
"type": "ACTIVE"
}
],
"confidenceCriteria": {
"sharedByOwner": true,
"checkedByExternalDataSource": true,
"numberOfSharingMembers": 0,
"lastConfidenceCheckAt": "2024-07-15",
"nextConfidenceCheckAt": "2024-07-15",
"confidenceLevel": 0
},
"hasChanged": true,
"siteMainAddress": {
"bpnReference": {
"referenceValue": "string",
"desiredBpn": "string",
"referenceType": "Bpn"
},
"addressName": "string",
"identifiers": [
{
"value": "string",
"type": "string",
"issuingBody": "string"
}
],
"states": [
{
"validFrom": "2024-07-15",
"validTo": "2024-07-15",
"type": "ACTIVE"
}
],
"confidenceCriteria": {
"sharedByOwner": true,
"checkedByExternalDataSource": true,
"numberOfSharingMembers": 0,
"lastConfidenceCheckAt": "2024-07-15",
"nextConfidenceCheckAt": "2024-07-15",
"confidenceLevel": 0
},
"physicalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "string",
"administrativeAreaLevel1": "string",
"administrativeAreaLevel2": "string",
"administrativeAreaLevel3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"street": {
"name": "string",
"houseNumber": "string",
"houseNumberSupplement": "string",
"milestone": "string",
"direction": "string",
"namePrefix": "string",
"additionalNamePrefix": "string",
"nameSuffix": "string",
"additionalNameSuffix": "string"
},
"companyPostalCode": "string",
"industrialZone": "string",
"building": "string",
"floor": "string",
"door": "string",
"taxJurisdictionCode": "string"
},
"alternativeAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "string",
"administrativeAreaLevel1": "string",
"postalCode": "string",
"city": "string",
"deliveryServiceType": "PO_BOX",
"deliveryServiceQualifier": "string",
"deliveryServiceNumber": "string"
},
"hasChanged": true
},
"siteMainIsLegalAddress": true
},
"additionalAddress": {
"bpnReference": {
"referenceValue": "string",
"desiredBpn": "string",
"referenceType": "Bpn"
},
"addressName": "string",
"identifiers": [
{
"value": "string",
"type": "string",
"issuingBody": "string"
}
],
"states": [
{
"validFrom": "2024-07-15",
"validTo": "2024-07-15",
"type": "ACTIVE"
}
],
"confidenceCriteria": {
"sharedByOwner": true,
"checkedByExternalDataSource": true,
"numberOfSharingMembers": 0,
"lastConfidenceCheckAt": "2024-07-15",
"nextConfidenceCheckAt": "2024-07-15",
"confidenceLevel": 0
},
"physicalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "string",
"administrativeAreaLevel1": "string",
"administrativeAreaLevel2": "string",
"administrativeAreaLevel3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"street": {
"name": "string",
"houseNumber": "string",
"houseNumberSupplement": "string",
"milestone": "string",
"direction": "string",
"namePrefix": "string",
"additionalNamePrefix": "string",
"nameSuffix": "string",
"additionalNameSuffix": "string"
},
"companyPostalCode": "string",
"industrialZone": "string",
"building": "string",
"floor": "string",
"door": "string",
"taxJurisdictionCode": "string"
},
"alternativeAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "string",
"administrativeAreaLevel1": "string",
"postalCode": "string",
"city": "string",
"deliveryServiceType": "PO_BOX",
"deliveryServiceQualifier": "string",
"deliveryServiceNumber": "string"
},
"hasChanged": true
},
"type": "LegalEntity"
},
"processingState": {
"resultState": "Pending",
"step": "CleanAndSync",
"stepState": "Queued",
"errors": [
{
"type": "Timeout",
"description": "string"
}
],
"createdAt": "2024-07-15",
"modifiedAt": "2024-07-15"
}
}
]
}
On malformed task search requests